Skip to content

Conversation

@EMaksy
Copy link
Member

@EMaksy EMaksy commented Nov 28, 2025

Description

This pr updates the released documentation in the latest branch. I was following our our critical hotfix workflow https://www.trento-project.io/docs/developer/trento-docs-site/collaboration-docs-team/docs-git-workflow.html#_3_applying_a_critical_hotfix.
With this we have also a nice history in the commits :)
image

When we release Trento 3.0 we will follow this workflow
https://www.trento-project.io/docs/developer/trento-docs-site/collaboration-docs-team/docs-git-workflow.html#_2_publishing_a_new_release

Features

  • Added mcp docs images
  • Remove docker from user facing docs
  • Move updated docker mentions to dev docs
  • Update Trento support Plugin
  • Add docker deployment

EMaksy and others added 5 commits November 28, 2025 10:53
* Remove docker from user facing docks

* Remove container and docker mentions

* Remove SP3

* Add env for wanda

* Use vars and upcast rpm

* Add explicit sle 16.0
* Fix TRNT-3895

* Add feedback
* Add local docs build

* Fix selinux permission

* Add workflow guide
@EMaksy EMaksy self-assigned this Nov 28, 2025
* Restructure trento install section

* Remove partial as it was included in kubernetes partial

* Aligned naming of partial and added revdate to kubernetes
@@ -0,0 +1,36 @@
== Local Documentation Preview with Docker
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is just developer docs for new way of preview antora with docker

:revdate: 2025-10-16


[[sec-trento-k8s-deployment]]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to trento-kubernetes-install.adoc[]

+
. Restart the application.

==== Enabling OpenID Connect when using Docker images
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part of docker mention removal

+
. Restart the application.

[[enabling-oauth-20-when-using-docker-images]]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part of docker mention removal

+
. Restart the application.

==== Enabling SAML when using Docker images
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part of docker mention removal

@EMaksy EMaksy marked this pull request as ready for review November 28, 2025 11:03
@EMaksy EMaksy requested review from abravosuse and dmpop November 28, 2025 11:03
[[sec-trento-install-trentoserver-on-existing-k8s-cluster]]
==== Installing {trserver} on an existing {k8s} cluster

{trserver} consists of a several components delivered as container images and intended for deployment on a {k8s} cluster. A manual production-ready deployment of these components requires {k8s} knowledge. Customers without in-house {k8s} expertise and who want to try {trento} with a minimum of effort, can use the {trento} Helm chart. This approach automates the deployment of all the required components on a single {k8s} cluster node. You can use the {trento} Helm chart to install {trserver} on a existing {k8s} cluster as follows:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{trserver} consists of a several components delivered as container images and intended for deployment on a {k8s} cluster. A manual production-ready deployment of these components requires {k8s} knowledge. Customers without in-house {k8s} expertise and who want to try {trento} with a minimum of effort, can use the {trento} Helm chart. This approach automates the deployment of all the required components on a single {k8s} cluster node. You can use the {trento} Helm chart to install {trserver} on a existing {k8s} cluster as follows:
{trserver} consists of a several components delivered as container images and intended for deployment on a {k8s} cluster. A manual production-ready deployment of these components requires {k8s} knowledge. Customers without in-house {k8s} expertise and those who want to try {trento} with a minimum of effort, can use the {trento} Helm chart. This approach automates the deployment of all the required components on a single {k8s} cluster node. You can use the {trento} Helm chart to install {trserver} on a existing {k8s} cluster as follows:

[[sec-trento-install-trentoserver-on-k3s]]
==== Installing {trserver} on K3s

If you do not have a {k8s} cluster, or have one but do not want to use it for {trento}, {suse} Rancher's K3s provides an alternative. To deploy {trserver} on K3s, you need a small server or VM (see <<sec-trento-server-requirements>> for minimum requirements) and follow steps in <<pro-trento-manually-installing>>.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you do not have a {k8s} cluster, or have one but do not want to use it for {trento}, {suse} Rancher's K3s provides an alternative. To deploy {trserver} on K3s, you need a small server or VM (see <<sec-trento-server-requirements>> for minimum requirements) and follow steps in <<pro-trento-manually-installing>>.
If you do not have a {k8s} cluster, or you have one but you do not want to use it for {trento}, you can use {suse} Rancher's K3s as an alternative. To deploy {trserver} on K3s, you need a server or VM (see <<sec-trento-server-requirements>> for minimum requirements) and follow steps in <<pro-trento-manually-installing>>.

Sender email for alert notifications

`ALERTING_RECIPIENT`::
Recipient email for alert notifications.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Recipient email for alert notifications.
Email address to receive alert notifications.

Copy link
Collaborator

@abravosuse abravosuse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job overall @EMaksy. Just some minor changes.

If you see a suggestion that changes nothing, it's because I first made a suggestion only valid for the new version. And when I realized it, I undid my changes. Sorry.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not understand this. It says the file has been deleted, but I can still see its content in the html generated by antora.

For the record, this information should not be removed from the user facing documentation. It's relevant.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From this section, we should remove the reference to Docker images.

// Variable List for tragent
{tragent}::
+
Delivery mechanism::: RPM package for {sles4sap} 15 SP3 and newer.
Copy link
Collaborator

@abravosuse abravosuse Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Delivery mechanism::: RPM package for {sles4sap} 15 SP3 and newer.
Delivery mechanism::: RPM package for {sles4sap} 15 SP3 and newer.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 25: Replace "{suse} recommends {suse} {rke} (RKE) version 1 or 2" with "{suse} recommends {{rke} version". 2."

Comment on lines 23 to 24
In case of a containerized deployment, provide the logs of the
trento-web and trento-wanda containers. Use `+docker ps+` to retrieve
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In case of a containerized deployment, provide the logs of the
trento-web and trento-wanda containers. Use `+docker ps+` to retrieve

Copy link
Collaborator

@abravosuse abravosuse Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete, also, lines 25 and 26. I could not include them in my suggestion.

{trserver} supports different deployment scenarios: {k8s}, systemd, and containers. A {k8s}-based deployment of {trserver} is cloud-native and OS-agnostic. It can be performed on the following services:
{trserver} supports different deployment scenarios: {k8s} and systemd. A {k8s}-based deployment of {trserver} is cloud-native and OS-agnostic. It can be performed on the following services:

* RKE1 ({rancher_k8s_engine} version 1)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* RKE1 ({rancher_k8s_engine} version 1)

* *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP3 or higher) distribution. The same applies to a containerized deployment.
* *{tragent}s* A registered {sles4sap} 15 (SP3 or higher) distribution.
* *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP4 or higher) or {sles4sap} 16.0 distribution.
* *{tragent}s* A registered {sles4sap} 15 (SP3 or higher) distribution.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* *{tragent}s* A registered {sles4sap} 15 (SP3 or higher) distribution.
* *{tragent}s* A registered {sles4sap} 15 (SP3 or higher) distribution.


* *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP3 or higher) distribution. The same applies to a containerized deployment.
* *{tragent}s* A registered {sles4sap} 15 (SP3 or higher) distribution.
* *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP4 or higher) or {sles4sap} 16.0 distribution.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP4 or higher) or {sles4sap} 16.0 distribution.
* *{trserver}* For a {k8s}-based deployment, you must have access to {suse} public registry for the deployment of {trserver} containers. For a systemd deployment, you must have a registered {sles4sap} 15 (SP3 or higher) distribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

4 participants